Skip to content

[core] Make hook.metadata a lazy Promise getter - #3988

Merged
pranaygp merged 4 commits into
mainfrom
lazy-hook-metadata-getter
Sep 9, 2026
Merged

[core] Make hook.metadata a lazy Promise getter#3988
pranaygp merged 4 commits into
mainfrom
lazy-hook-metadata-getter

Conversation

@pranaygp

@pranaygp pranaygp commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Summary & Motivation

Hydrating a hook's metadata is a decrypting READ: it needs the owning run's payload keys, and resolving those costs a run fetch plus a run-key API round trip (~350ms). getHookByToken() did that work eagerly on every lookup that found a metadata-bearing hook, so callers that only wanted runId/token paid for it anyway — and so did hook resumption, which never reads metadata at all.

hook.metadata is now a getter that returns a memoized Promise, the same shape as run.returnValue. The lookup is one read again; the hydration and the key resolution behind it happen on first access, or never.

const hook = await getHookByToken(token); // one read, no key work
const metadata = await hook.metadata;     // hydrates here, memoized

Expected perf win

Datadog, production, trailing 24h (2026-09-09):

Call Median p95 Spans / 24h
Vercel API GET /v1/workflow/run-key/:deploymentId — the round trip a lookup no longer pays unless metadata is awaited 170 ms 521 ms 297k
workflow-server GET /v2/hooks/by-token — the one read a lookup still pays 19 ms 264 ms 41k

So a getHookByToken() that finds a metadata-bearing hook and never awaits metadata drops from roughly 190 ms to 19 ms at the median (and from ~785 ms to ~264 ms at p95), plus one runs.get on pre-resumeContext hooks. Callers that only need runId/token, and every resumeHook() on a hook that carries metadata, get the whole saving. resumeWebhook() on a webhook with respondWith is unchanged: it must read metadata, and it still resolves the key exactly once.

Picks up @AndrewBarba's "skip metadata lookups in all the places we can" (vercel/eve#3043) and @pranaygp's "+1 here on make the metadata lookup a lazy promise getter in hook".

What changed

  • getHookByToken() returns a Hook (exported from workflow/api, the runtime-side hook type whose metadata is lazy, mirroring Run for runs): one hooks.getByToken, nothing else. The getter is defined in place on the record the World returned, the same object the eager path used to mutate.
  • resumeWebhook() is the one resume path that must read metadata (respondWith lives there), so it awaits the getter. Behavior is unchanged: a default webhook that stored no metadata still resolves undefined with no key lookup and still lets resumeHook seal to the run's public key, and a metadata-bearing webhook still resolves the run key exactly once end to end — the key the hydration resolved is reused for the payload write.
  • resumeHook()'s returned hook gets the same accessor. Previously it handed back the raw record, whose metadata was still the serialized bytes; it now hydrates lazily, which costs nothing when unread.
  • getHookByTokenWithKey is gone, replaced by withLazyMetadata + a direct hooks.getByToken. The durable write-then-wake resume path itself is untouched.

Breaking change

hook.metadata must be awaited. Like run.returnValue, the accessor is non-enumerable, so it is absent from { ...hook } and JSON.stringify(hook) — that's deliberate: an incidental spread would otherwise kick off hydration nobody awaits, and an unconsumed rejected Promise takes the process down. Forward the awaited value explicitly if you need to serialize it. The World-level Hook type in @workflow/world is untouched; world.hooks.getByToken still returns raw serialized metadata.

Test Plan

New packages/core/src/runtime/get-hook-by-token.test.ts (9 tests) covers: a lookup costs exactly one read even with metadata present; first access hydrates and memoizes, deriving read-side keys from the stored resume context with no run read; a metadata-less hook resolves undefined with no I/O; the pre-resumeContext fallback reads the run only on access; a hydration failure surfaces on await, not on lookup; a failed lookup still propagates; spread/JSON.stringify don't trigger hydration; and a resumed hook carries the accessor without double-wrapping.

The existing resume-hook*.test.ts suites pin the resume behavior that must not move — in particular that a default webhook pays no key lookup and seals, and that a metadata-bearing webhook resolves the key exactly once. All 64 tests across the four hook suites pass, and the full packages/core unit suite is green (2350 passed, 3 expected fail). E2E hook tests were updated for the new access shape.

Docs Preview

Page v5
getHookByToken /v5/docs/api-reference/workflow-api/get-hook-by-token
resumeHook (returns Hook from workflow/api) /v5/docs/api-reference/workflow-api/resume-hook#returns
What's new in v5 (breaking-changes row; page now first in the sidebar) /v5/docs/whats-new#application-code
World storage (world.hooks.getByToken() returns raw metadata) /v5/docs/api-reference/workflow-runtime/world/storage#look-up-hook-by-token

Only the v5 pages are updated: the change ships in the 5.x beta, and v4 documents the shipped stable API. createHook's metadata option gains a line about reading it back, which renders from TSDoc on /v5/docs/api-reference/workflow/create-hook. The migrating-workflow-v4-to-v5 skill gains the await hook.metadata rewrite rule (version 0.2.10). The /v5/docs redirect to getting-started is unchanged; whats-new is only added to the sidebar, in the same position PR #3714 adds it.

Server-side follow-up (not in this PR)

workflow-server's GET /v2/hooks/by-token still resolves metadata eagerly because the SDK sends no remoteRefBehavior and the server defaults to resolve: for a metadata-bearing hook that is one extra DynamoDB run read (to enforce expiredAt) plus the ref resolution (in-memory for inline dbrf refs up to 64 KB, an S3 GET above that). Passing resolveData: 'none' from the lookup and decoding lazily on first access would remove that too; tracked separately.

Expected win: the by-token route's median is already 19 ms, so this is a tail fix, not a median fix. It removes one DynamoDB point read (single-digit ms) from every metadata-bearing lookup and the S3 GET (tens of ms, and the likely driver of the 264 ms p95 above) for metadata above the 64 KB inline cutoff. Expect the route's p95 to move, the median to barely change, and the SDK-side win above to dominate either way.

🤖 Generated with Claude Code

@pranaygp
pranaygp requested a review from a team as a code owner September 4, 2026 20:31
Copilot AI lite review requested due to automatic review settings September 4, 2026 20:31
@changeset-bot

changeset-bot Bot commented Sep 4, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 2d28ade

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 16 packages
Name Type
@workflow/core Major
workflow Major
@workflow/world-testing Patch
@workflow/builders Patch
@workflow/cli Patch
@workflow/next Patch
@workflow/nitro Patch
@workflow/vitest Patch
@workflow/web-shared Patch
@workflow/web Patch
@workflow/astro Patch
@workflow/nest Patch
@workflow/rollup Patch
@workflow/sveltekit Patch
@workflow/vite Patch
@workflow/nuxt Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel

vercel Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
example-nextjs-workflow-turbopack Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
example-nextjs-workflow-webpack Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
example-workflow Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workbench-astro-workflow Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workbench-express-workflow Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workbench-fastify-workflow Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workbench-hono-workflow Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workbench-nestjs-workflow Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workbench-nitro-workflow Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workbench-nuxt-workflow Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workbench-python-workflow Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workbench-sveltekit-workflow Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workbench-tanstack-start-workflow Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workbench-vite-workflow Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workflow-docs Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workflow-swc-playground Building Building Preview, v0 Sep 9, 2026 6:50pm UTC
workflow-tarballs Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC
workflow-web Ready Ready Preview, v0 Sep 9, 2026 6:50pm UTC

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The exported HookWithLazyMetadata.metadata type currently doesn’t reflect that it can resolve to undefined, which contradicts the implementation and docs and can mislead API consumers.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR updates the core runtime hook API so hook.metadata is hydrated lazily via a memoized Promise getter, avoiding the run fetch + run-key round trip unless a caller actually reads metadata. This keeps hot paths like hook resumption at a single hooks.getByToken read while preserving existing webhook behavior that depends on metadata (respondWith).

Changes:

  • Introduced HookWithLazyMetadata and updated getHookByToken() / resumeHook() to return hooks with metadata as a lazy, non-enumerable Promise getter.
  • Updated resumeWebhook() to explicitly await hook.metadata (the one resume path that needs metadata) and to reuse the derived read-side key for the payload write.
  • Added/updated unit + e2e + docs coverage to reflect the new access pattern and to assert “single read unless accessed”.
File summaries
File Description
packages/workflow/src/api.ts Re-exports HookWithLazyMetadata from the public workflow/api surface.
packages/core/src/runtime/resume-hook.ts Implements lazy metadata accessor, updates hook lookup/resume return types, and reuses metadata-derived keys in resumeWebhook.
packages/core/src/runtime/resume-hook.parallel.test.ts Updates test commentary to match the new inline by-token fetch behavior.
packages/core/src/runtime/resume-hook.fast-path.test.ts Updates test commentary for the new “await metadata” behavior on default webhooks.
packages/core/src/runtime/get-hook-by-token.test.ts Adds focused unit tests covering lazy hydration, memoization, I/O behavior, and non-enumerability.
packages/core/src/runtime.ts Re-exports HookWithLazyMetadata from @workflow/core/runtime.
packages/core/src/create-hook.ts Updates API docs to tell users hook.metadata must be awaited outside the workflow.
packages/core/e2e/e2e.test.ts Updates e2e call sites to await hook.metadata when reading custom metadata.
packages/core/e2e/e2e-region.test.ts Updates multi-region e2e assertions to await hook.metadata.
docs/content/docs/v5/api-reference/workflow-api/get-hook-by-token.mdx Documents the new lazy Promise getter semantics and updates examples/return type.
.changeset/lazy-hook-metadata-getter.md Declares a major breaking change and explains the new hook.metadata semantics.
Review details
  • Files reviewed: 11/11 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread packages/core/src/runtime/resume-hook.ts
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

❌ Failed E2E Tests

vercel-http-transport (3 failed)

example (1 failed):

  • hookDisposeTestWorkflow - hook token reuse after explicit disposal while workflow still running | wrun_41M23R5YBC0GZRNP732H710CSS

express (1 failed):

  • hookClaimOnlyMutexWorkflow - hook works as a pure run mutex without payload data | wrun_41M23R5QXG0GJ1TH0ZHFDWJYFN

hono (1 failed):

  • AbortController abortThrowIfAbortedMidFlightWorkflow: throwIfAborted in a polling loop bails when abort fires

⚠️ Flaky E2E Tests (passed on retry)

These tests failed at least once and passed on a retry. A recurring entry here is a real race worth investigating.

53 flaky tests
  • abortAlreadyAbortedWorkflow: pre-aborted signal seen by step (fastify)
  • abortExternalSignalWorkflow: signal passed as workflow input (sveltekit)
  • abortFetchUncaughtWorkflow: uncaught fetch AbortError is FatalError, no retries (fastify)
  • abortHookOrderingWorkflow [hook-first-hook-first]: hook.then → addEventListener → resumeHook → abort() (fastify)
  • abortHookOrderingWorkflow [listener-first-abort-first]: addEventListener → hook.then → abort() → resumeHook (nest)
  • abortReasonTypesWorkflow: various abort reason types propagate correctly (vite)
  • abortViaHookWorkflow: external hook triggers abort on in-flight step (nest)
  • Calculator.calculate - static workflow method using static step methods from another class (hono)
  • cancelRun via CLI - cancelling a running workflow (express)
  • cancelRun via CLI - cancelling a running workflow (nextjs-turbopack)
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously (astro)
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously (fastify)
  • cross-file imports preserve message and stack trace (tanstack-start)
  • cross-file step error preserves message and function names in stack (astro)
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context (nuxt)
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE (example)
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE (sveltekit)
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE (tanstack-start)
  • distributedAbortController - manual abort triggers signal (hono)
  • distributedAbortController - reconnect to existing controller (sveltekit)
  • FatalError fails immediately without retries (example)
  • getterStepWorkflow - getter functions with "use step" directive (nuxt)
  • hookAdoptOwnerResultWorkflow - duplicate adopts the owner result via conflict.returnValue (python)
  • hookCleanupTestWorkflow - hook token reuse after workflow completion (hono)
  • hookCleanupTestWorkflow - hook token reuse after workflow completion (nextjs-webpack)
  • hookCleanupTestWorkflow - hook token reuse after workflow completion (sveltekit)
  • hookDisposeTestWorkflow - hook token reuse after explicit disposal while workflow still running (fastify)
  • hookGetConflictThenStepParallelWorkflow - hook.getConflict() continuation step runs alongside other steps (python)
  • hookGetConflictWorkflow - hook.getConflict() resolves with the conflicting run when token is already registered (nextjs-webpack)
  • hookSignalOwnerWorkflow - duplicate forwards its payload to the owner via resumeHook (nitro)
  • hookSupersedeOwnerWorkflow - duplicate cancels the owner and claims the released token (nuxt)
  • hookTokenReuseLoopWorkflow - same run recreates a hook with the same token after dispose() (hono)
  • hookTokenReuseLoopWorkflow - same run recreates a hook with the same token after dispose() (vite)
  • hookWithSleepWorkflow - hook payloads delivered correctly with concurrent sleep (nextjs-webpack)
  • hookWorkflow is not resumable via public webhook endpoint (example)
  • hookWorkflow is not resumable via public webhook endpoint (nextjs-webpack)
  • hookWorkflow is not resumable via public webhook endpoint (python)
  • mixed provider and function tools (nextjs-webpack)
  • nested function calls preserve message and stack trace (vite)
  • no startIndex (reads all chunks) (express)
  • promiseRaceWorkflow (python)
  • resume-or-start route pattern - resumeHook retried after start() reaches the new run (nextjs-webpack)
  • retainedInterleavingWorkflow (astro)
  • retainedInterleavingWorkflow (nest)
  • RetryableError respects custom retryAfter delay (nuxt)
  • runClassSerializationWorkflow - Run instances serialize across workflow/step boundaries (express)
  • sleepWithSequentialStepsWorkflow - sequential steps work with concurrent sleep (control) (example)
  • sleepWithSequentialStepsWorkflow - sequential steps work with concurrent sleep (control) (fastify)
  • step throw of a non-Error value preserves it as cause on the wrapping FatalError (nuxt)
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars) (tanstack-start)
  • stepWinsRaceWorkflow (hono)
  • stepWinsRaceWorkflow (nextjs-webpack)
  • thisSerializationWorkflow - step function invoked with .call() and .apply() (example)

🛠 Infra Events (absorbed by the harness)

Platform anomalies the e2e harness detected and worked around (e.g. a run the queue never picked up, replaced by a fresh run). Clustered timestamps indicate a backend blip; a steady drip indicates a platform issue worth escalating.

  • cold-start-warmup · suite warmup (tanstack-start) · at 18:52:29Z · abandoned wrun_01M23R6GZV9DZCW6MT2EEVE5NZ

E2E Test Summary

Summary
Passed Failed Skipped Total
✅ ▲ Vercel Production 3662 0 685 4347
✅ 💻 Local Development 3922 0 586 4508
✅ 📦 Local Production 3922 0 586 4508
✅ 🐘 Local Postgres 3922 0 586 4508
✅ 🪟 Windows 320 0 2 322
✅ 🌐 Cross-language Conformance 68 0 74 142
❌ vercel-http-transport 820 3 143 966
✅ vercel-multi-region 27 0 0 27
✅ vercel-ws-transport 399 0 84 483
Total 17062 3 2746 19811
Details by Category

✅ ▲ Vercel Production

App Passed Failed Skipped
✅ astro-node 133 0 28
✅ astro-quickjs 133 0 28
✅ example-node 133 0 28
✅ example-quickjs 133 0 28
✅ express-node 133 0 28
✅ express-quickjs 133 0 28
✅ fastify-node 133 0 28
✅ fastify-quickjs 133 0 28
✅ hono-node 133 0 28
✅ hono-quickjs 133 0 28
✅ nest-node 133 0 28
✅ nest-quickjs 133 0 28
✅ nextjs-turbopack-node 158 0 3
✅ nextjs-turbopack-quickjs 158 0 3
✅ nextjs-webpack-node 158 0 3
✅ nextjs-webpack-quickjs 158 0 3
✅ nitro-node 133 0 28
✅ nitro-quickjs 133 0 28
✅ nuxt-node 133 0 28
✅ nuxt-quickjs 133 0 28
✅ python-node 66 0 95
✅ sveltekit-node 152 0 9
✅ sveltekit-quickjs 152 0 9
✅ tanstack-start-node 133 0 28
✅ tanstack-start-quickjs 133 0 28
✅ vite-node 133 0 28
✅ vite-quickjs 133 0 28

✅ 💻 Local Development

App Passed Failed Skipped
✅ astro-stable-node 134 0 27
✅ astro-stable-quickjs 134 0 27
✅ express-stable-node 134 0 27
✅ express-stable-quickjs 134 0 27
✅ fastify-stable-node 134 0 27
✅ fastify-stable-quickjs 134 0 27
✅ hono-stable-node 134 0 27
✅ hono-stable-quickjs 134 0 27
✅ nest-stable-node 134 0 27
✅ nest-stable-quickjs 134 0 27
✅ nextjs-turbopack-canary-node 141 0 20
✅ nextjs-turbopack-canary-quickjs 141 0 20
✅ nextjs-turbopack-stable-node 160 0 1
✅ nextjs-turbopack-stable-quickjs 160 0 1
✅ nextjs-webpack-canary-node 141 0 20
✅ nextjs-webpack-canary-quickjs 141 0 20
✅ nextjs-webpack-stable-node 160 0 1
✅ nextjs-webpack-stable-quickjs 160 0 1
✅ nitro-stable-node 134 0 27
✅ nitro-stable-quickjs 134 0 27
✅ nuxt-stable-node 134 0 27
✅ nuxt-stable-quickjs 134 0 27
✅ sveltekit-stable-node 153 0 8
✅ sveltekit-stable-quickjs 153 0 8
✅ tanstack-start-node 134 0 27
✅ tanstack-start-quickjs 134 0 27
✅ vite-stable-node 134 0 27
✅ vite-stable-quickjs 134 0 27

✅ 📦 Local Production

App Passed Failed Skipped
✅ astro-stable-node 134 0 27
✅ astro-stable-quickjs 134 0 27
✅ express-stable-node 134 0 27
✅ express-stable-quickjs 134 0 27
✅ fastify-stable-node 134 0 27
✅ fastify-stable-quickjs 134 0 27
✅ hono-stable-node 134 0 27
✅ hono-stable-quickjs 134 0 27
✅ nest-stable-node 134 0 27
✅ nest-stable-quickjs 134 0 27
✅ nextjs-turbopack-canary-node 141 0 20
✅ nextjs-turbopack-canary-quickjs 141 0 20
✅ nextjs-turbopack-stable-node 160 0 1
✅ nextjs-turbopack-stable-quickjs 160 0 1
✅ nextjs-webpack-canary-node 141 0 20
✅ nextjs-webpack-canary-quickjs 141 0 20
✅ nextjs-webpack-stable-node 160 0 1
✅ nextjs-webpack-stable-quickjs 160 0 1
✅ nitro-stable-node 134 0 27
✅ nitro-stable-quickjs 134 0 27
✅ nuxt-stable-node 134 0 27
✅ nuxt-stable-quickjs 134 0 27
✅ sveltekit-stable-node 153 0 8
✅ sveltekit-stable-quickjs 153 0 8
✅ tanstack-start-node 134 0 27
✅ tanstack-start-quickjs 134 0 27
✅ vite-stable-node 134 0 27
✅ vite-stable-quickjs 134 0 27

✅ 🐘 Local Postgres

App Passed Failed Skipped
✅ astro-stable-node 134 0 27
✅ astro-stable-quickjs 134 0 27
✅ express-stable-node 134 0 27
✅ express-stable-quickjs 134 0 27
✅ fastify-stable-node 134 0 27
✅ fastify-stable-quickjs 134 0 27
✅ hono-stable-node 134 0 27
✅ hono-stable-quickjs 134 0 27
✅ nest-stable-node 134 0 27
✅ nest-stable-quickjs 134 0 27
✅ nextjs-turbopack-canary-node 141 0 20
✅ nextjs-turbopack-canary-quickjs 141 0 20
✅ nextjs-turbopack-stable-node 160 0 1
✅ nextjs-turbopack-stable-quickjs 160 0 1
✅ nextjs-webpack-canary-node 141 0 20
✅ nextjs-webpack-canary-quickjs 141 0 20
✅ nextjs-webpack-stable-node 160 0 1
✅ nextjs-webpack-stable-quickjs 160 0 1
✅ nitro-stable-node 134 0 27
✅ nitro-stable-quickjs 134 0 27
✅ nuxt-stable-node 134 0 27
✅ nuxt-stable-quickjs 134 0 27
✅ sveltekit-stable-node 153 0 8
✅ sveltekit-stable-quickjs 153 0 8
✅ tanstack-start-node 134 0 27
✅ tanstack-start-quickjs 134 0 27
✅ vite-stable-node 134 0 27
✅ vite-stable-quickjs 134 0 27

✅ 🪟 Windows

App Passed Failed Skipped
✅ nextjs-turbopack-node 160 0 1
✅ nextjs-turbopack-quickjs 160 0 1

✅ 🌐 Cross-language Conformance

App Passed Failed Skipped
✅ python 68 0 74

❌ vercel-http-transport

App Passed Failed Skipped
❌ example 132 1 28
❌ express 132 1 28
❌ hono 132 1 28
✅ nextjs-turbopack 158 0 3
✅ nitro 133 0 28
✅ vite 133 0 28

✅ vercel-multi-region

App Passed Failed Skipped
✅ nextjs-turbopack 27 0 0

✅ vercel-ws-transport

App Passed Failed Skipped
✅ example 133 0 28
✅ express 133 0 28
✅ vite 133 0 28

📋 View full workflow run

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

📊 Workflow Benchmarks

commit 2d28ade · Wed, 09 Sep 2026 19:14:56 GMT · run logs

Backend: vercel · app: nextjs-turbopack

Metric Scenario Best (ms) P75 (ms) P90 (ms) P99 (ms) Samples
TTFS step 258 (-60%) 💚 1439 🔴 (+30%) 🔻 1566 🔴 (+36%) 🔻 1581 🔴 (+34%) 🔻 30
TTFS stream 317 (+35%) 🔻 1361 🔴 (+27%) 🔻 1470 🔴 (+33%) 🔻 1611 🔴 (+38%) 🔻 30
TTFS hook + stream 1209 (+189%) 🔻 1738 🔴 (+29%) 🔻 1814 🔴 (+31%) 🔻 1937 🔴 (+36%) 🔻 30
Fan-out TTFS Promise.all(100 steps) 590 (-1.3%) 2042 (+16%) 🔻 2060 (+13%) 2243 (+22%) 🔻 10
Fan-out TTLS Promise.all(100 steps) 2149 (-3.8%) 3821 (±0%) 3834 (-18%) 💚 8624 (+52%) 🔻 10
STSO 1020 steps (inline) 112 (+20%) 🔻 142 (+4.4%) 157 (+2.6%) 251 (+14%) 1019
WO 1020 steps 140505 (+4.1%) 140505 (+4.1%) 140505 (+4.1%) 140505 (+4.1%) 1
CRTT first chunk (pooled) 66 (-5.7%) 122 (-29%) 💚 188 (+1.6%) 3154 (+1551%) 🔻 28

Streams

Scenario CRTT 1st p75 p90 p99 CDV max iters
paced control (100/s, 60B) 137 (+51%) 324 (+30%) 1330 (+290%) 3137 (+386%) 145 (-41%) 10
size sweep (100/s, 160B-12KB) 87.5 (-5%) 198 (-40%) 358 (-32%) 700 (-29%) 165 (-45%) 10
replay gateway-gpt-5.4-nano-2000t (1x) 88 (-52%) 194 (-29%) 254 (-43%) 440 (-41%) 214 (-42%) 3
replay eve-gpt-5.6-sol-2000t (1x) 80.5 (-25%) 141 (-32%) 185 (-71%) 4487 (+10%) 2404 (+19%) 2
replay eve-gpt-5.6-sol-2000t (2x) 76 (-56%) 215 (-49%) 305 (-48%) 496 (-40%) 239 (-35%) 3
📈 STSO distribution vs main (inline / queue-hop histograms)

1020 steps (inline)

Cumulative STSO time: main 133880ms → this run 140316ms (Δ +6436ms, +5%)

 50-100 ms  ┃                         main   2  this   0    -2
100-150 ms  ██████████████████████┃█  main 884  this 849   -35
150-200 ms  ███┃                      main 118  this 154   +36
200-250 ms  ┃                         main  11  this   5    -6
250-300 ms  ┃                         main   3  this  10    +7
350-400 ms  ┃                         main   1  this   1    +0
📈 CRTT drill-down vs main (RTT distributions & profiles)
variant  RTT 1ms→5s+             avg         p50           p90           p99     n
control  ······▂█▄▁▁▁·  385.7 (+98%)  149 (-16%)  1330 (+290%)  3137 (+386%)  3000
sweep    ······▂█▃▁···  163.3 (-34%)  141 (-31%)    358 (-32%)    700 (-29%)  3000
gw 1x    ·····▁▃█▂▁···  137.9 (-24%)  118 (-18%)    254 (-43%)    440 (-41%)  5295
eve 1x   ·····▁▆█▁··▁·  192.4 (-31%)  107 (-25%)    185 (-71%)   4487 (+10%)  5186
eve 2x   ·····▁▃█▃▁···  158.9 (-40%)  137 (-41%)    305 (-48%)    496 (-40%)  7779

RTT over stream progress (avg per tenth of stream, bars scaled min→max):

control  █▇▅▇█▆▄▃▂▁  235–491ms
sweep    ▅▅█▇▄▁▂▂▂▁  136–208ms
gw 1x    ▅▃▃▁▂▂▂█▂▄  119–179ms
eve 1x   ▁▁▁▁▁▁▁▁▁█  98–889ms
eve 2x   ▁▁▂▁▁▂▃█▄▂  125–279ms

RTT by chunk size (avg per log size bin, ~160B → ~12KB serialized, bars scaled min→max):

sweep  ▆█▆▁▃▂▅  162–165ms

Delivery jitter over stream progress (avg positive CDV per tenth of stream, bars scaled min→max):

control  ▃▂▁█▃▃▂▃▃▁  32–91ms
sweep    ▃█▇▇▄▆▁▄▄▂  43–70ms
gw 1x    ▅▆▄▁▄▅▆█▃▅  31–51ms
eve 1x   ▂▂▂▁▂▂▂▁▂█  19–58ms
eve 2x   ▃▇▂▁▄▃█▆▅▆  21–27ms
📜 Previous results (2)

01f8f8d

Wed, 09 Sep 2026 17:41:20 GMT · run logs

vercel / nextjs-turbopack

Metric Scenario Best (ms) P75 (ms) P90 (ms) P99 (ms) Samples
TTFS step 1229 (+500%) 🔻 1334 🔴 (+24%) 🔻 1363 🔴 (-0.7%) 1404 🔴 (-6.0%) 30
TTFS stream 188 (-80%) 💚 1240 🔴 (+22%) 🔻 1274 🔴 (+24%) 🔻 1402 🔴 (+32%) 🔻 30
TTFS hook + stream 568 (-53%) 💚 1535 🔴 (+20%) 🔻 1560 🔴 (+21%) 🔻 2177 🔴 (+43%) 🔻 30
Fan-out TTFS Promise.all(100 steps) 592 (+10%) 1938 (+193%) 🔻 1966 (+171%) 🔻 2196 (+36%) 🔻 10
Fan-out TTLS Promise.all(100 steps) 1966 (+7.3%) 4496 (+79%) 🔻 8077 (+219%) 🔻 8602 (+23%) 🔻 10
STSO 1020 steps (inline) 93 (-17%) 💚 139 (+0.7%) 158 (+2.6%) 709 (+225%) 🔻 1019
WO 1020 steps 148036 (+6.3%) 148036 (+6.3%) 148036 (+6.3%) 148036 (+6.3%) 1
CRTT first chunk (pooled) 68 (+28%) 🔻 121 (+15%) 🔻 136 (+5.4%) 230 (-20%) 💚 28

Streams

Scenario CRTT 1st p75 p90 p99 CDV max iters
paced control (100/s, 60B) 85.5 (+12%) 149 (-20%) 210 (-43%) 709 (+9%) 123 (-29%) 10
size sweep (100/s, 160B-12KB) 113 (+26%) 196 (+26%) 374 (+56%) 872 (+115%) 183 (+44%) 10
replay gateway-gpt-5.4-nano-2000t (1x) 104 (+60%) 149 (+3%) 223 (+9%) 553 (+39%) 395 (+15%) 3
replay eve-gpt-5.6-sol-2000t (1x) 88.5 (-18%) 146 (+9%) 201 (+11%) 425 (-28%) 338 (-18%) 2
replay eve-gpt-5.6-sol-2000t (2x) 124 (+31%) 207 (-23%) 328 (-14%) 595 (+9%) 300 (-27%) 3

b89b982

Fri, 04 Sep 2026 21:25:30 GMT · run logs

vercel / nextjs-turbopack

Metric Scenario Best (ms) P75 (ms) P90 (ms) P99 (ms) Samples
TTFS step 196 (-74%) 💚 1272 🔴 (+20%) 🔻 1293 🔴 (+15%) 🔻 1403 🔴 (+1.6%) 30
TTFS stream 214 (-78%) 💚 1344 🔴 (+31%) 🔻 1353 🔴 (+29%) 🔻 1447 🔴 (+34%) 🔻 30
TTFS hook + stream 453 (-63%) 💚 1546 🔴 (+11%) 1584 🔴 (+6.0%) 5758 🔴 (+197%) 🔻 30
Fan-out TTFS Promise.all(100 steps) 589 1787 2009 2078 10
Fan-out TTLS Promise.all(100 steps) 1883 3346 3943 8394 10
STSO 1020 steps (inline) 109 137 158 223 1019
WO 1020 steps 136220 (-65%) 💚 136220 (-65%) 💚 136220 (-65%) 💚 136220 (-65%) 💚 1
CRTT first chunk (pooled) 61 106 134 173 28

Streams

Scenario CRTT 1st p75 p90 p99 CDV max iters
paced control (100/s, 60B) 91.5 155 221 361 164 10
size sweep (100/s, 160B-12KB) 85 198 410 663 254 10
replay gateway-gpt-5.4-nano-2000t (1x) 89 167 1817 3998 375 3
replay eve-gpt-5.6-sol-2000t (1x) 82 142 200 427 340 2
replay eve-gpt-5.6-sol-2000t (2x) 88 179 270 590 326 3
ℹ️ Metric definitions & methodology

Streams: first-chunk RTT (the stream-open path, before any buffering/backpressure), CRTT percentiles, and worst delivery stall (CDV max). Cells are medians across iterations; per-run values in the artifacts. No 🔴/🟢 marks until targets attach.

The collapsed STSO distribution section above buckets every step gap, split inline (same warm process — pure framework overhead) vs queue-hop (fresh process — dispatch, reinit, replay). = main, = this run, = fill.

The collapsed CRTT drill-down: per-variant RTT histograms (fixed log bins, · = empty) and mean RTT/positive-CDV profile lines over stream progress and chunk size. Histograms, avgs, and profiles merge exactly across runs; p50–p99 are percentile-of-percentiles. Per-index rows live in the artifacts.

Best/P75/P90/P99 deltas compare against the most recent benchmark run on main at the time of this run. 🔻 flags a delta worse than +15%, 💚 one better than −15%.

Metrics — TTFS: time to first step body (in-deployment start() → first step body) · Fan-out TTFS: fan-out time to first step (in-deployment start() → first of the parallel step bodies to complete) · Fan-out TTLS: fan-out time to last step (in-deployment start() → last of the parallel step bodies to complete, i.e. when the Promise.all resolves) · STSO: step-to-step overhead (gap between consecutive step bodies) · WO: workflow overhead (whole-run time outside step bodies, in-deployment anchored) · CRTT: chunk round-trip time (per-chunk write → read latency, one clock domain: deployment → stream backend → same deployment) · CDV: chunk delay variation / delivery jitter (inter-arrival gap minus inter-write gap per seq-adjacent pair; skew-free; the row is each run's MAX positive value, so one stall moves it)

Scenarios — step: one trivial no-op step, no stream; no hooks, so the run stays in turbo mode (in-process fast path) · stream: one streaming step; no hooks, so the run stays in turbo mode (in-process fast path) · hook + stream: registers a hook before one step, which exits turbo mode (dispatch path) · 1020 steps: 1020 trivial sequential steps; STSO is measured between consecutive steps in the given step ranges, and WO is the whole-run overhead outside step bodies · Promise.all(100 steps): 100 trivial no-op steps started together in a single Promise.all; Fan-out TTFS is the first of them to complete and Fan-out TTLS the last, both from the in-deployment clientStart, so their gap is the spread the runtime adds across the fan-out · paced control (100/s, 60B): the control: 300 tiny (~60B) deltas metronome-paced at 100/s — zero workload structure, so it reads the transport floor and flush cadence, and disambiguates transport-wide vs workload-specific when a replay row moves · size sweep (100/s, 160B-12KB): same pacing as the control with deltas padded in rotation across seven log-spaced sizes (~160B–12KB) — rotation decouples size from stream position, so it isolates whether chunk size causes latency · replay gateway-gpt-5.4-nano-2000t (1x): raw provider SSE cadence captured at the AI gateway boundary (gpt-5.4-nano, the most popular gateway model; per-token deltas p50 208B = the modal production chunk size), replayed exactly as measured — the typical customer's workload; its CDV is the typical customer's real delivery jitter · replay eve-gpt-5.6-sol-2000t (1x): a captured eve turn (gpt-5.6-sol, the most-used demanding eve model; ~2000 output tokens = production p50 turn length) replayed exactly as measured — eve's envelope protocol re-ships the cumulative message so sizes ramp 142B→13KB; the demanding outlier tenant's reality · replay eve-gpt-5.6-sol-2000t (2x): the same eve capture at 2x — the headroom/stress row; real fast-tier models emit the same chunk sizes at proportionally higher rate, so time compression is a faithful speed model · first chunk (pooled): every run's seq-0 RTT pooled across all stream scenarios — the first chunk precedes any workload differentiation, so pooling samples one shared stream-open path with exact percentiles

Replay cadences (semantic sha256) — eve-gpt-5.6-sol-2000t eaf22f5946e7c61f3c65c7006d550df180cfabd4e706254a09f22aec0cfb420d · gateway-gpt-5.4-nano-2000t 6f24ac518b6b83ff1d0e85a5fe78230db192716d66a7fc6b2fe022752001d041

🔴 marks a percentile over its target (within target is left unmarked). Targets (p75/p90/p99, ms) — TTFS 200/300/600

All timestamps are deployment-side; runs are triggered in-deployment, so the CI runner and api.vercel.com sit outside every measured window. TTFS = start() → first step body (includes dispatch + any cold start); Fan-out TTFS/TTLS = first/last step completion of one Promise.all from the same anchor (the gap is the runtime’s fan-out spread); STSO/WO between step bodies; CRTT inside the workflow (excludes the api.vercel.com read path).

Cold starts stay in the numbers (real bursty-workload latency, inflates P75+); Best is the warm floor.

vercel Bot and others added 2 commits September 9, 2026 10:10
Hydrating a hook's metadata is a decrypting READ: it needs the owning
run's payload keys, and resolving those costs a run fetch plus a
`run-key` API round trip (~350ms). `getHookByToken()` did that work
eagerly on every lookup that found a metadata-bearing hook, so callers
that only wanted `runId`/`token` — and hook resumption, which never
reads metadata at all — paid for it anyway.

`metadata` is now a getter returning a memoized Promise, the same shape
as `run.returnValue`. The lookup is one read again; hydration and the
key resolution behind it happen on first access, or never.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

Co-Authored-By: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>
…ion skill, and the resumeHook reference

Adds the breaking-change row to the v5 What's new page and puts that page
in the sidebar as the first visible entry (the /v5/docs redirect to
getting-started is unchanged). Teaches the migrating-workflow-v4-to-v5
skill the `await hook.metadata` rewrite and bumps its version. Points the
resumeHook reference at HookWithLazyMetadata, and notes on the World
storage page that world.hooks.getByToken() returns raw serialized
metadata.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
`getHookByToken()` and `resumeHook()` return `Hook`, not a separate
`HookWithLazyMetadata`: one public hook type whose `metadata` is a lazy
Promise, mirroring `Run` for runs. The World-level record from
`@workflow/world` is unchanged and is referenced as `WorldHook` inside the
runtime.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Comment thread .changeset/lazy-hook-metadata-getter.md Outdated
Comment thread docs/content/docs/v5/api-reference/workflow-api/get-hook-by-token.mdx Outdated
Comment thread packages/core/src/runtime/resume-hook.ts Outdated
Comment thread .changeset/lazy-hook-metadata-getter.md Outdated
Comment thread docs/content/docs/v5/api-reference/workflow-api/get-hook-by-token.mdx Outdated

@VaguelySerious VaguelySerious left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some inline changes for comments/docs.

Note Nate's question about Object.create, would be curious too

…and docs wording

Review feedback: the hook record a World returns is a fresh object per
lookup and the eager path mutated it anyway, so define the getter on it
directly instead of copying it with Object.create(). The changeset is one
sentence, and the docs describe hydration as extra network round trips
rather than decryption, since not every World encrypts.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

No backport to stable for efbdc21 (AI decision).

This is a breaking API change and performance optimization for the v5 line: hook.metadata becomes a lazy, non-enumerable Promise getter and a new Hook type is exported from workflow/api, carrying a major changeset. It changes the shape of an existing public API to avoid an eager key-resolution round trip rather than fixing a user-visible defect, so it does not qualify as a stability fix for the maintenance line.

To override, re-run the Backport to stable workflow manually via workflow_dispatch and paste this commit SHA into the ref input:

efbdc213a0a70f8be2a147a0af195a4d9d82f0fe

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants